<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>esapi.reference.default_user.DefaultUser</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="esapi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="esapi-module.html">Package&nbsp;esapi</a> ::
        <a href="esapi.reference-module.html">Package&nbsp;reference</a> ::
        <a href="esapi.reference.default_user-module.html">Module&nbsp;default_user</a> ::
        Class&nbsp;DefaultUser
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="esapi.reference.default_user.DefaultUser-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DefaultUser</h1><p class="nomargin-top"><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+    
         |    
 <a href="esapi.user.User-class.html">user.User</a> --+
             |
            <strong class="uidshort">DefaultUser</strong>
</pre>

<hr />
<p>The reference implementation of the User interface. This 
  implementation is pickled/shelved into a flat file.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">account_name</span>)</span><br />
      Instantiates a new user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#login_with_password" class="summary-sig-name">login_with_password</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">password</span>)</span><br />
      Login with a password.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.login_with_password">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#logout" class="summary-sig-name">logout</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Logout this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.logout">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#is_logged_in" class="summary-sig-name">is_logged_in</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if this user is currently logged in.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_logged_in">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_locale" class="summary-sig-name" onclick="show_private();">_get_locale</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns:
      the user's locale</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_locale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_locale" class="summary-sig-name" onclick="show_private();">_set_locale</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">locale</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_locale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#add_role" class="summary-sig-name">add_role</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">role</span>)</span><br />
      If role is a string, it will be lower()'d.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.add_role">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#remove_role" class="summary-sig-name">remove_role</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">role</span>)</span><br />
      Removes a role from this user's account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.remove_role">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#is_in_role" class="summary-sig-name">is_in_role</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">role</span>)</span><br />
      Checks if this user's account is assigned a particular role.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_in_role">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_roles" class="summary-sig-name" onclick="show_private();">_get_roles</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets the roles assigned to a particular account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_roles">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_roles" class="summary-sig-name" onclick="show_private();">_set_roles</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">roles</span>)</span><br />
      Sets the roles for this account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_roles">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#add_roles" class="summary-sig-name">add_roles</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">roles</span>)</span><br />
      Adds a list of roles to this user's account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.add_roles">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#verify_password" class="summary-sig-name">verify_password</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">password</span>)</span><br />
      Verify that the supplied password matches the password for this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.verify_password">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#change_password" class="summary-sig-name">change_password</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">old_password</span>,
        <span class="summary-sig-arg">new_password1</span>,
        <span class="summary-sig-arg">new_password2</span>)</span><br />
      Sets the user's password, performing a verification of the user's old
      password, the equality of the two new passwords, and the strength of 
      the new password.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.change_password">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_last_password_change_time" class="summary-sig-name" onclick="show_private();">_get_last_password_change_time</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets the date of the user's last password change.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_last_password_change_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_last_password_change_time" class="summary-sig-name" onclick="show_private();">_set_last_password_change_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>)</span><br />
      Sets the time of the last password change for this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_last_password_change_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#disable" class="summary-sig-name">disable</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Disable this user's account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.disable">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#enable" class="summary-sig-name">enable</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Enable this user's account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.enable">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#is_enabled" class="summary-sig-name">is_enabled</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if this user's account is currently enabled.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_enabled">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_account_id" class="summary-sig-name" onclick="show_private();">_get_account_id</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets this user's account id number.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_account_id">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_account_name" class="summary-sig-name" onclick="show_private();">_get_account_name</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets this user's account name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_account_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_account_name" class="summary-sig-name" onclick="show_private();">_set_account_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Sets this user's account name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_account_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_csrf_token" class="summary-sig-name" onclick="show_private();">_get_csrf_token</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets the CSRF token for this user's current session.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_csrf_token">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#reset_csrf_token" class="summary-sig-name">reset_csrf_token</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns a token to be used as a prevention against CSRF attacks.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.reset_csrf_token">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_expiration_time" class="summary-sig-name" onclick="show_private();">_get_expiration_time</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets the date that this user's account will expire.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_expiration_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_expiration_time" class="summary-sig-name" onclick="show_private();">_set_expiration_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">expiration_time</span>)</span><br />
      Sets the date and time when this user's account will expire.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_expiration_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#is_expired" class="summary-sig-name">is_expired</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if this user's account is expired.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_expired">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#get_failed_login_count" class="summary-sig-name">get_failed_login_count</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the number of failed login attempts since the last successful
      login for an account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.get_failed_login_count">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#increment_failed_login_count" class="summary-sig-name">increment_failed_login_count</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Increment the failed login count.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.increment_failed_login_count">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_last_failed_login_time" class="summary-sig-name" onclick="show_private();">_get_last_failed_login_time</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets the date of the last failed login time for a user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_last_failed_login_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_last_failed_login_time" class="summary-sig-name" onclick="show_private();">_set_last_failed_login_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>)</span><br />
      Set the date and time of the last failed login for this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_last_failed_login_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_last_host_address" class="summary-sig-name" onclick="show_private();">_get_last_host_address</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets the last host address used by the user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_last_host_address">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_last_host_address" class="summary-sig-name" onclick="show_private();">_set_last_host_address</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">address</span>)</span><br />
      Sets the last remote host address used by this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_last_host_address">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_last_login_time" class="summary-sig-name" onclick="show_private();">_get_last_login_time</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets the date of the last successful login time for a user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_last_login_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_last_login_time" class="summary-sig-name" onclick="show_private();">_set_last_login_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>)</span><br />
      Sets the time of the last successful login for this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_last_login_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_screen_name" class="summary-sig-name" onclick="show_private();">_get_screen_name</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gets the screen name (alias) for this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_screen_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_screen_name" class="summary-sig-name" onclick="show_private();">_set_screen_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">new_screen_name</span>)</span><br />
      Sets the screen name (alias) for this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_screen_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#add_session" class="summary-sig-name">add_session</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">session</span>)</span><br />
      Adds a session for this User.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.add_session">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#remove_session" class="summary-sig-name">remove_session</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">session</span>)</span><br />
      Removes a session for this User.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.remove_session">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#get_sessions" class="summary-sig-name">get_sessions</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the list of sessions associated with this user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.get_sessions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#is_anonymous" class="summary-sig-name">is_anonymous</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if the user is anonymous.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_anonymous">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#is_session_absolute_timeout" class="summary-sig-name">is_session_absolute_timeout</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if this user's session has exceeded the absolute time out 
      based on ESAPI's configuration.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_session_absolute_timeout">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#is_session_timeout" class="summary-sig-name">is_session_timeout</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if the user's session has timed out from inactivity based on 
      ESAPI's configuration.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_session_timeout">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#lock" class="summary-sig-name">lock</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Lock this user's account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.lock">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#unlock" class="summary-sig-name">unlock</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Unlock this user's account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.unlock">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#is_locked" class="summary-sig-name">is_locked</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if this user's account is locked.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_locked">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__getstate__"></a><span class="summary-sig-name">__getstate__</span>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.__getstate__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__setstate__"></a><span class="summary-sig-name">__setstate__</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>)</span><br />
      Restore unpickleable instance attributes like logger.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.__setstate__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="esapi.user.User-class.html">user.User</a></code></b>:
      <code><a href="esapi.user.User-class.html#get_event_dict">get_event_dict</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="IDLE_TIMEOUT_LENGTH"></a><span class="summary-name">IDLE_TIMEOUT_LENGTH</span> = <code title="datetime.timedelta(0, 1200)">datetime.timedelta(0, 1200)</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="ABSOLUTE_TIMEOUT_LENGTH"></a><span class="summary-name">ABSOLUTE_TIMEOUT_LENGTH</span> = <code title="datetime.timedelta(0, 1200)">datetime.timedelta(0, 1200)</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="MAX_ROLE_LENGTH"></a><span class="summary-name">MAX_ROLE_LENGTH</span> = <code title="250">250</code>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#locale" class="summary-name">locale</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#roles" class="summary-name">roles</a><br />
      The roles assigned to a particular user
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#last_password_change_time" class="summary-name">last_password_change_time</a><br />
      The time of the last password change for this user.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#account_id" class="summary-name">account_id</a><br />
      The User's account ID
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#account_name" class="summary-name">account_name</a><br />
      The User's account name
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#csrf_token" class="summary-name">csrf_token</a><br />
      The User's CSRF token
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#expiration_time" class="summary-name">expiration_time</a><br />
      The date and time that this User's account will expire
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#last_failed_login_time" class="summary-name">last_failed_login_time</a><br />
      The date and time of the last failed login for the user.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#last_host_address" class="summary-name">last_host_address</a><br />
      The last host address used by this user
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#last_login_time" class="summary-name">last_login_time</a><br />
      The date and time the user last successfully logged in.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="esapi.reference.default_user.DefaultUser-class.html#screen_name" class="summary-name">screen_name</a><br />
      The screen name or alias for the User
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">account_name</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Instantiates a new user.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>account_name</code></strong> - The name of this user's account.</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="login_with_password"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">login_with_password</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">password</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.login_with_password">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Login with a password.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>password</code></strong> - the password</li>
    </ul></dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="esapi.exceptions.AuthenticationException-class.html">AuthenticationException</a></strong></code> - if login fails</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#login_with_password">user.User.login_with_password</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="logout"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">logout</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.logout">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Logout this user. Implementations should call 
  ESAPI.authenticator().logout(self)</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="esapi.user.User-class.html#logout">user.User.logout</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_logged_in"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_logged_in</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_logged_in">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if this user is currently logged in.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>true if the user is logged in</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#is_logged_in">user.User.is_logged_in</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_locale"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_locale</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_locale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>the user's locale</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_locale" onclick="show_private();">user.User._get_locale</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_locale"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_locale</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">locale</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_locale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>locale</code></strong> - the locale to set</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_locale" onclick="show_private();">user.User._set_locale</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="add_role"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_role</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">role</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.add_role">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>If role is a string, it will be lower()'d.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>role</code></strong> - the role to add</li>
    </ul></dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="esapi.exceptions.AuthenticationException-class.html">AuthenticationException</a></strong></code></li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#add_role">user.User.add_role</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="remove_role"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">remove_role</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">role</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.remove_role">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes a role from this user's account.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>role</code></strong> - the role to remove</li>
    </ul></dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="esapi.exceptions.AuthenticationException-class.html">AuthenticationException</a></strong></code></li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#remove_role">user.User.remove_role</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_in_role"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_in_role</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">role</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_in_role">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if this user's account is assigned a particular role.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>role</code></strong> - the role for which to check.</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>true if the role has been assigned to the user.</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#is_in_role">user.User.is_in_role</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_roles"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_roles</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_roles">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the roles assigned to a particular account.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>a tuple of the roles of the current user</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_roles" onclick="show_private();">user.User._get_roles</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_roles"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_roles</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">roles</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_roles">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the roles for this account.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>roles</code></strong> - the new roles</li>
    </ul></dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="esapi.exceptions.AuthenticationException-class.html">AuthenticationException</a></strong></code></li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_roles" onclick="show_private();">user.User._set_roles</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="add_roles"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_roles</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">roles</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.add_roles">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a list of roles to this user's account.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>roles</code></strong> - A list of roles to add.</li>
    </ul></dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="esapi.exceptions.AuthenticationException-class.html">AuthenticationException</a></strong></code></li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#add_roles">user.User.add_roles</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="verify_password"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">verify_password</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">password</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.verify_password">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Verify that the supplied password matches the password for this user. 
  This method is typically used for 'reauthentication' for the most 
  sensitive functions, such as transactions, changing email address, and 
  changing other account information.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>password</code></strong> - the password that the user entered</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>true if the password matches the account's password</dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="esapi.exceptions.EncryptionException-class.html">EncryptionException</a></strong></code></li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#verify_password">user.User.verify_password</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="change_password"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">change_password</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">old_password</span>,
        <span class="sig-arg">new_password1</span>,
        <span class="sig-arg">new_password2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.change_password">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the user's password, performing a verification of the user's old 
  password, the equality of the two new passwords, and the strength of the 
  new password.</p>
  <p>Be sure to send in separate form values for the two new passwords. Do 
  NOT send in the same form value.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>old_password</code></strong> - the old password</li>
        <li><strong class="pname"><code>new_password1</code></strong> - the new password</li>
        <li><strong class="pname"><code>new_password2</code></strong> - the new password again, used to verify that that the new password
          was typed correctly.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#change_password">user.User.change_password</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_last_password_change_time"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_last_password_change_time</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_last_password_change_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the date of the user's last password change.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>a datetime of the last password change.</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_last_password_change_time" onclick="show_private();">user.User._get_last_password_change_time</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_last_password_change_time"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_last_password_change_time</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">time</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_last_password_change_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the time of the last password change for this user.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>time</code></strong> - the date and time when the user last changed his/her password.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_last_password_change_time" onclick="show_private();">user.User._set_last_password_change_time</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="disable"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">disable</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.disable">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Disable this user's account.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="esapi.user.User-class.html#disable">user.User.disable</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="enable"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">enable</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.enable">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Enable this user's account.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="esapi.user.User-class.html#enable">user.User.enable</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_enabled"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_enabled</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_enabled">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if this user's account is currently enabled.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>true if the user is enabled.</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#is_enabled">user.User.is_enabled</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_account_id"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_account_id</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_account_id">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets this user's account id number.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>the account id</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_account_id" onclick="show_private();">user.User._get_account_id</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_account_name"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_account_name</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_account_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets this user's account name.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>the account name</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_account_name" onclick="show_private();">user.User._get_account_name</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_account_name"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_account_name</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_account_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets this user's account name.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>name</code></strong> - the new account name</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_account_name" onclick="show_private();">user.User._set_account_name</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_csrf_token"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_csrf_token</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_csrf_token">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the CSRF token for this user's current session.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>the CSRF token</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_csrf_token" onclick="show_private();">user.User._get_csrf_token</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="reset_csrf_token"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">reset_csrf_token</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.reset_csrf_token">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a token to be used as a prevention against CSRF attacks. This 
  token should be added to all links and forms. The application should 
  verify that all requests contain the token, or they may have been 
  generated by a CSRF attack. It is generally best to perform the check in 
  a centralized location, either a filter or controller.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>the new CSRF token</dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="esapi.exceptions.AuthenticationException-class.html">AuthenticationException</a></strong></code></li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#reset_csrf_token">user.User.reset_csrf_token</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_expiration_time"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_expiration_time</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_expiration_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the date that this user's account will expire.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>a datetime of when the account will expire.</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_expiration_time" onclick="show_private();">user.User._get_expiration_time</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_expiration_time"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_expiration_time</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">expiration_time</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_expiration_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the date and time when this user's account will expire.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>expiration_time</code></strong> - the new expiration time</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_expiration_time" onclick="show_private();">user.User._set_expiration_time</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_expired"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_expired</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_expired">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if this user's account is expired.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>true if the account is expired</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#is_expired">user.User.is_expired</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="get_failed_login_count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_failed_login_count</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.get_failed_login_count">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of failed login attempts since the last successful 
  login for an account. This method is intended to be used as a part of the
  account lockout feature, to help protect against brute force attacks. 
  However, the implementor should be aware that lockouts can be used to 
  prevent access to an application by a legitimate user, and should 
  consider the risk of denial of service.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>the number of failed login attempts since the last successful 
          login</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#get_failed_login_count">user.User.get_failed_login_count</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="increment_failed_login_count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">increment_failed_login_count</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.increment_failed_login_count">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Increment the failed login count.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="esapi.user.User-class.html#increment_failed_login_count">user.User.increment_failed_login_count</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_last_failed_login_time"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_last_failed_login_time</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_last_failed_login_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the date of the last failed login time for a user. This date 
  should be used in a message to users after a successful login, to notify 
  them of potential attack activity on their account.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>a datetime of the last failed login</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_last_failed_login_time" onclick="show_private();">user.User._get_last_failed_login_time</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_last_failed_login_time"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_last_failed_login_time</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">time</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_last_failed_login_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set the date and time of the last failed login for this user.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>time</code></strong> - the date and time when the user last failed to login correctly.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_last_failed_login_time" onclick="show_private();">user.User._set_last_failed_login_time</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_last_host_address"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_last_host_address</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_last_host_address">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the last host address used by the user. This will be used in any 
  log messages generated by the processing of a request.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>the last host address used by the user</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_last_host_address" onclick="show_private();">user.User._get_last_host_address</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_last_host_address"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_last_host_address</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">address</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_last_host_address">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the last remote host address used by this user.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>address</code></strong> - The address of the user's current source host.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_last_host_address" onclick="show_private();">user.User._set_last_host_address</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_last_login_time"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_last_login_time</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_last_login_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the date of the last successful login time for a user. This date 
  should be used in a message to the user after a successful login, to 
  notify them of potential attack activity on their account.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>a datetime of the last successful login</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_last_login_time" onclick="show_private();">user.User._get_last_login_time</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_last_login_time"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_last_login_time</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">time</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_last_login_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the time of the last successful login for this user.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>time</code></strong> - the date and time when the user last successfully logged in.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_last_login_time" onclick="show_private();">user.User._set_last_login_time</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_get_screen_name"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_screen_name</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._get_screen_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the screen name (alias) for this user.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>the screen name of the current user</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_get_screen_name" onclick="show_private();">user.User._get_screen_name</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_screen_name"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_screen_name</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">new_screen_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser._set_screen_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the screen name (alias) for this user.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>new_screen_name</code></strong> - the new screen name</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#_set_screen_name" onclick="show_private();">user.User._set_screen_name</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="add_session"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_session</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">session</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.add_session">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a session for this User.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>session</code></strong> - the session to associate with this user.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#add_session">user.User.add_session</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="remove_session"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">remove_session</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">session</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.remove_session">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes a session for this User.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>session</code></strong> - the session to dissociate with this user.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#remove_session">user.User.remove_session</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="get_sessions"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_sessions</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.get_sessions">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the list of sessions associated with this user.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>a tuple of the user's sessions.</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#get_sessions">user.User.get_sessions</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_anonymous"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_anonymous</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_anonymous">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if the user is anonymous.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>true if the user is anonymous</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#is_anonymous">user.User.is_anonymous</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_session_absolute_timeout"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_session_absolute_timeout</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_session_absolute_timeout">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if this user's session has exceeded the absolute time out based
  on ESAPI's configuration.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>true if the user's session has exceed the absolute time out.</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#is_session_absolute_timeout">user.User.is_session_absolute_timeout</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_session_timeout"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_session_timeout</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_session_timeout">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if the user's session has timed out from inactivity based on 
  ESAPI's configuration.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>true if the user's session has timed out from inactivity based on
          ESAPI's configuration.</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#is_session_timeout">user.User.is_session_timeout</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="lock"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">lock</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.lock">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Lock this user's account.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="esapi.user.User-class.html#lock">user.User.lock</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="unlock"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">unlock</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.unlock">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Unlock this user's account.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="esapi.user.User-class.html#unlock">user.User.unlock</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="is_locked"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_locked</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="esapi.reference.default_user-pysrc.html#DefaultUser.is_locked">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if this user's account is locked.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>true of the account is locked</dd>
    <dt>Overrides:
        <a href="esapi.user.User-class.html#is_locked">user.User.is_locked</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="locale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">locale</h3>
  
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_locale" class="summary-sig-name" onclick="show_private();">_get_locale</a>(<span class="summary-sig-arg">self</span>)</span>
        - Returns:
      the user's locale
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_locale" class="summary-sig-name" onclick="show_private();">_set_locale</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">locale</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="roles"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">roles</h3>
  <p>The roles assigned to a particular user</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_roles" class="summary-sig-name" onclick="show_private();">_get_roles</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets the roles assigned to a particular account.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_roles" class="summary-sig-name" onclick="show_private();">_set_roles</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">roles</span>)</span>
        - Sets the roles for this account.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="last_password_change_time"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">last_password_change_time</h3>
  <p>The time of the last password change for this user.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_last_password_change_time" class="summary-sig-name" onclick="show_private();">_get_last_password_change_time</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets the date of the user's last password change.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_last_password_change_time" class="summary-sig-name" onclick="show_private();">_set_last_password_change_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>)</span>
        - Sets the time of the last password change for this user.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="account_id"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">account_id</h3>
  <p>The User's account ID</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_account_id" class="summary-sig-name" onclick="show_private();">_get_account_id</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets this user's account id number.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="account_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">account_name</h3>
  <p>The User's account name</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_account_name" class="summary-sig-name" onclick="show_private();">_get_account_name</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets this user's account name.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_account_name" class="summary-sig-name" onclick="show_private();">_set_account_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span>
        - Sets this user's account name.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="csrf_token"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">csrf_token</h3>
  <p>The User's CSRF token</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_csrf_token" class="summary-sig-name" onclick="show_private();">_get_csrf_token</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets the CSRF token for this user's current session.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="expiration_time"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">expiration_time</h3>
  <p>The date and time that this User's account will expire</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_expiration_time" class="summary-sig-name" onclick="show_private();">_get_expiration_time</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets the date that this user's account will expire.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_expiration_time" class="summary-sig-name" onclick="show_private();">_set_expiration_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">expiration_time</span>)</span>
        - Sets the date and time when this user's account will expire.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="last_failed_login_time"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">last_failed_login_time</h3>
  <p>The date and time of the last failed login for the user.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_last_failed_login_time" class="summary-sig-name" onclick="show_private();">_get_last_failed_login_time</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets the date of the last failed login time for a user.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_last_failed_login_time" class="summary-sig-name" onclick="show_private();">_set_last_failed_login_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>)</span>
        - Set the date and time of the last failed login for this user.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="last_host_address"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">last_host_address</h3>
  <p>The last host address used by this user</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_last_host_address" class="summary-sig-name" onclick="show_private();">_get_last_host_address</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets the last host address used by the user.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_last_host_address" class="summary-sig-name" onclick="show_private();">_set_last_host_address</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">address</span>)</span>
        - Sets the last remote host address used by this user.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="last_login_time"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">last_login_time</h3>
  <p>The date and time the user last successfully logged in.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_last_login_time" class="summary-sig-name" onclick="show_private();">_get_last_login_time</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets the date of the last successful login time for a user.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_last_login_time" class="summary-sig-name" onclick="show_private();">_set_last_login_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>)</span>
        - Sets the time of the last successful login for this user.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="screen_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">screen_name</h3>
  <p>The screen name or alias for the User</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_get_screen_name" class="summary-sig-name" onclick="show_private();">_get_screen_name</a>(<span class="summary-sig-arg">self</span>)</span>
        - Gets the screen name (alias) for this user.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="esapi.reference.default_user.DefaultUser-class.html#_set_screen_name" class="summary-sig-name" onclick="show_private();">_set_screen_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">new_screen_name</span>)</span>
        - Sets the screen name (alias) for this user.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="esapi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Nov  8 16:04:22 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
